Fix for missing periodic task name in results by ntindicator · Pull Request #812 · celery/django-celery-beat

ntindicator · 2024-10-08T13:33:12Z

Fix for issue #376 in django-celery-results. The message broker rabbitmq isn't picking up periodic_task_name when it's passed as a keyword arg to task.apply_async(). If it's added to the headers in apply_async() it becomes available in the request object in django-celery-results. For this change to work the following commit also needs to be merged, otherwise it won't get picked up in the results.

If the task isn't triggered by django-celery-beat, but is done with code, such as using delay() or apply_async(), it will be missing, unless it's added to the headers in apply_async(). delay() doesn't support the extra options. E.g. When triggering a child task with delay() Periodic Task Name was missing in the Task Results.

These changes haven't been tested with Redis or any other message broker, only rabbitmq. CELERY_RESULT_EXTENDED was set to True in the settings.

Tested with:
celery==5.4.0
django-celery-beat==2.7.0
django-celery-results==2.5.1
Django==4.2.16
rabbitmq==4.0.2

Nusnus

Is it possible to add unit tests please?

codecov · 2024-10-10T14:38:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.22%. Comparing base (78d3230) to head (62f0529).
Report is 28 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #812      +/-   ##
==========================================
+ Coverage   86.92%   87.22%   +0.29%     
==========================================
  Files          32       32              
  Lines         933      939       +6     
  Branches      124       76      -48     
==========================================
+ Hits          811      819       +8     
+ Misses        103      102       -1     
+ Partials       19       18       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

* https://www.python.org/downloads/release/python-3130/ * https://pythoninsider.blogspot.com/2024/10/python-3130-final-released.html * https://devguide.python.org/versions/ * https://docs.djangoproject.com/en/stable/faq/install/#what-python-version-can-i-use-with-django

cclauss · 2024-10-14T14:59:59Z

Linting errors in pre-commit:

flake8...................................................................Failed
- hook id: flake8
- exit code: 1

django_celery_beat/admin.py:252:9: E303 too many blank lines (2)
django_celery_beat/admin.py:254:59: E231 missing whitespace after ':'
django_celery_beat/admin.py:257:30: E128 continuation line under-indented for visual indent
django_celery_beat/admin.py:257:59: E231 missing whitespace after ':'
t/unit/test_schedulers.py:874:5: E303 too many blank lines (2)
t/unit/test_schedulers.py:879:80: E501 line too long (81 > 79 characters)

updates: - [github.com/asottile/pyupgrade: v3.17.0 → v3.18.0](asottile/pyupgrade@v3.17.0...v3.18.0) - [github.com/adamchainz/django-upgrade: 1.21.0 → 1.22.1](adamchainz/django-upgrade@1.21.0...1.22.1) - [github.com/tox-dev/pyproject-fmt: 2.2.4 → 2.3.0](tox-dev/pyproject-fmt@2.2.4...2.3.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

auvipy

depends on celery/django-celery-results#445 (review)

updates: - [github.com/astral-sh/ruff-pre-commit: v0.6.9 → v0.7.0](astral-sh/ruff-pre-commit@v0.6.9...v0.7.0) - [github.com/tox-dev/pyproject-fmt: 2.3.0 → 2.4.3](tox-dev/pyproject-fmt@2.3.0...2.4.3) - [github.com/abravalheri/validate-pyproject: v0.20.2 → v0.21](abravalheri/validate-pyproject@v0.20.2...v0.21) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

updates: - [github.com/asottile/pyupgrade: v3.18.0 → v3.19.0](asottile/pyupgrade@v3.18.0...v3.19.0) - [github.com/astral-sh/ruff-pre-commit: v0.7.0 → v0.7.1](astral-sh/ruff-pre-commit@v0.7.0...v0.7.1) - [github.com/tox-dev/pyproject-fmt: 2.4.3 → v2.4.3](tox-dev/pyproject-fmt@2.4.3...v2.4.3) - [github.com/abravalheri/validate-pyproject: v0.21 → v0.22](abravalheri/validate-pyproject@v0.21...v0.22) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

related issuses: 240

updates: - [github.com/astral-sh/ruff-pre-commit: v0.7.1 → v0.7.2](astral-sh/ruff-pre-commit@v0.7.1...v0.7.2) - [github.com/tox-dev/pyproject-fmt: v2.4.3 → v2.5.0](tox-dev/pyproject-fmt@v2.4.3...v2.5.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* fix long period task will never be triggered * fix (schedulers): when model.date_changed is None, use _default.now() * test (schedulers): add test for when model.last_run_at is None * test (scheduler): revise the comment --------- Co-authored-by: chentiantian <chentiantian@myhexin.com>

updates: - [github.com/astral-sh/ruff-pre-commit: v0.7.2 → v0.7.3](astral-sh/ruff-pre-commit@v0.7.2...v0.7.3) - [github.com/abravalheri/validate-pyproject: v0.22 → v0.23](abravalheri/validate-pyproject@v0.22...v0.23) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 4 to 5. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@v4...v5) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

updates: - [github.com/astral-sh/ruff-pre-commit: v0.7.3 → v0.7.4](astral-sh/ruff-pre-commit@v0.7.3...v0.7.4) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

updates: - [github.com/astral-sh/ruff-pre-commit: v0.7.4 → v0.8.0](astral-sh/ruff-pre-commit@v0.7.4...v0.8.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

updates: - [github.com/adamchainz/django-upgrade: 1.22.1 → 1.22.2](adamchainz/django-upgrade@1.22.1...1.22.2) - [github.com/astral-sh/ruff-pre-commit: v0.8.0 → v0.8.1](astral-sh/ruff-pre-commit@v0.8.0...v0.8.1) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

updates: - [github.com/astral-sh/ruff-pre-commit: v0.8.1 → v0.8.2](astral-sh/ruff-pre-commit@v0.8.1...v0.8.2) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

auvipy

can you please rebase?

…jango-celery-beat into periodic-task-name-results

Review addressed

auvipy · 2025-01-12T07:37:10Z

Thanks for your efforts

fix for missing periodic task name in results

3ab299e

Nusnus previously requested changes Oct 8, 2024

View reviewed changes

fix error in admin, add to scheduler headers,tests

a9a7490

pre-commit-ci bot and others added 2 commits October 14, 2024 19:34

formatting changes

9be2125

auvipy requested changes Oct 21, 2024

View reviewed changes

auvipy approved these changes Oct 23, 2024

View reviewed changes

auvipy requested a review from Nusnus October 23, 2024 11:52

pre-commit-ci bot and others added 2 commits October 28, 2024 21:30

fix 'exipres' not working normal as expected (celery#816)

5f0e38a

related issuses: 240

This was referenced Nov 4, 2024

add periodic_task_name to headers #819

Closed

Periodic task name is missing in TaskResult celery/django-celery-results#376

Closed

pre-commit-ci bot and others added 8 commits November 4, 2024 18:17

[pre-commit.ci] pre-commit autoupdate (celery#826)

c7337cf

updates: - [github.com/astral-sh/ruff-pre-commit: v0.7.3 → v0.7.4](astral-sh/ruff-pre-commit@v0.7.3...v0.7.4) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

[pre-commit.ci] pre-commit autoupdate (celery#827)

ca609dd

updates: - [github.com/astral-sh/ruff-pre-commit: v0.7.4 → v0.8.0](astral-sh/ruff-pre-commit@v0.7.4...v0.8.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

[pre-commit.ci] pre-commit autoupdate (celery#830)

5ea76e8

updates: - [github.com/astral-sh/ruff-pre-commit: v0.8.1 → v0.8.2](astral-sh/ruff-pre-commit@v0.8.1...v0.8.2) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

auvipy requested changes Dec 14, 2024

View reviewed changes

ntindicator and others added 4 commits December 16, 2024 01:42

fix for missing periodic task name in results

ac9535f

fix error in admin, add to scheduler headers,tests

7167f48

formatting changes

e6475e6

Merge branch 'periodic-task-name-results' of github.com:ntindicator/d…

62f0529

…jango-celery-beat into periodic-task-name-results

auvipy approved these changes Jan 12, 2025

View reviewed changes

auvipy merged commit 78c1b2c into celery:main Jan 12, 2025

auvipy added the bug label Mar 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix for missing periodic task name in results#812

Fix for missing periodic task name in results#812
auvipy merged 20 commits intocelery:mainfrom
ntindicator:periodic-task-name-results

ntindicator commented Oct 8, 2024

Uh oh!

Nusnus left a comment

Uh oh!

codecov bot commented Oct 10, 2024 •

edited

Loading

Uh oh!

cclauss commented Oct 14, 2024

Uh oh!

auvipy left a comment

Uh oh!

auvipy left a comment

Uh oh!

auvipy commented Jan 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

ntindicator commented Oct 8, 2024

Uh oh!

Nusnus left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cclauss commented Oct 14, 2024

Uh oh!

auvipy left a comment

Choose a reason for hiding this comment

Uh oh!

auvipy left a comment

Choose a reason for hiding this comment

Uh oh!

auvipy commented Jan 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented Oct 10, 2024 •

edited

Loading